GetCheckPointUserRecord

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > GetCheckPointUserRecord

## GetCheckPointUserRecord

The GetCheckPointUserRecord function will retrieve as users record from the database.

###### Syntax

TRecordResponse * GetCheckPointUserRecord( long ACheckPointUserID, BSTR ASessionID, TCheckPointUserRecord *& ACheckPointUserRecord ) ;

###### Parameters

ACheckPointUserID

[IN] This is a numeric value that represents the User's ID. This parameter is used to locate the user's record.

ASessionID

[IN] This is the session ID of the logged in user.

ACheckPointUserRecord

[OUT] This is a TCheckPointUserRecord class which will be returned to the user. This class will contain the users record that is retrieved. The fields of interest are:

- CheckPointUserID - the user id of the user

- IsAdministrator - if the user is an administrator

- CheckPointUserName - the user's name

- PrimaryEMail - the user's email

- PasswordHash - the user's password hash

- Deleted - if the users is deleted

###### Remarks

The return value of this function is to verify that it was successful. The retrieved user record will be located in the out parameter ACheckPointUserRecord.

Only administrators are allowed to use this function.

###### Return Value

Returns the custom class TRecordResponse. The fields of interest that is related to this method are:

- Success- True will be returned if this function was successful, otherwise false will be returned.

- PrimaryKeyValue- the CheckPoint User ID of the user that is retrieved.

- ErrorMessage- if an error occurred, the associated error message can be found in this field.

###### Function Information

Exposed By Interface: | "ICheckPointService"
Exposed In ISAPI DLL: | "checkpoint.dll"